Autogenerated HTML docs for v1.5.4-rc0-36-g7680
diff --git a/git-help.html b/git-help.html index b58cd0d..97c1027 100644 --- a/git-help.html +++ b/git-help.html
@@ -272,7 +272,7 @@ </div> <h2>SYNOPSIS</h2> <div class="sectionbody"> -<p><em>git help</em> [-a|--all|-i|--info|-w|--web] [COMMAND]</p> +<p><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</p> </div> <h2>DESCRIPTION</h2> <div class="sectionbody"> @@ -283,7 +283,7 @@ printed on the standard output.</p> <p>If a git command is named, a manual page for that command is brought up. The <em>man</em> program is used by default for this purpose, but this -can be overriden by other options.</p> +can be overriden by other options or configuration variables.</p> <p>Note that <em>git --help …</em> is identical as <em>git help …</em> because the former is internally converted into the latter.</p> </div> @@ -309,6 +309,16 @@ </p> </dd> <dt> +-m|--man +</dt> +<dd> +<p> + Use the <em>man</em> program to display the manual page. This may be + used to override a value set in the <em>help.format</em> + configuration variable. +</p> +</dd> +<dt> -w|--web </dt> <dd> @@ -318,18 +328,55 @@ </p> <p>The web browser can be specified using the configuration variable <em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of -these config variables is set, the <em>git-browse-help</em> script (called by -<em>git-help</em>) will pick a suitable default.</p> +these config variables is set, the <em>git-browse--help</em> helper script +(called by <em>git-help</em>) will pick a suitable default.</p> <p>You can explicitly provide a full path to your prefered browser by setting the configuration variable <em>browser.<tool>.path</em>. For example, you can configure the absolute path to firefox by setting -<em>browser.firefox.path</em>. Otherwise, <em>git-browse-help</em> assumes the tool +<em>browser.firefox.path</em>. Otherwise, <em>git-browse--help</em> assumes the tool is available in PATH.</p> <p>Note that the script tries, as much as possible, to display the HTML page in a new tab on an already opened browser.</p> </dd> </dl> </div> +<h2>CONFIGURATION VARIABLES</h2> +<div class="sectionbody"> +<p>If no command line option is passed, the <em>help.format</em> configuration +variable will be checked. The following values are supported for this +variable; they make <em>git-help</em> behave as their corresponding command +line option:</p> +<ul> +<li> +<p> +"man" corresponds to <em>-m|--man</em>, +</p> +</li> +<li> +<p> +"info" corresponds to <em>-i|--info</em>, +</p> +</li> +<li> +<p> +"web" or "html" correspond to <em>-w|--web</em>, +</p> +</li> +</ul> +<p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.<tool>.path</em> will also +be checked if the <em>web</em> format is choosen (either by command line +option or configuration variable). See <em>-w|--web</em> in the OPTIONS +section above.</p> +<p>Note that these configuration variables should probably be set using +the <em>--global</em> flag, for example like this:</p> +<div class="listingblock"> +<div class="content"> +<pre><tt>$ git config --global help.format web +$ git config --global web.browser firefox</tt></pre> +</div></div> +<p>as they are probably more user specific than repository specific. +See <a href="git-config.html">git-config(1)</a> for more information about this.</p> +</div> <h2>Author</h2> <div class="sectionbody"> <p>Written by Junio C Hamano <gitster@pobox.com> and the git-list @@ -347,7 +394,7 @@ </div> <div id="footer"> <div id="footer-text"> -Last updated 13-Dec-2007 02:42:55 UTC +Last updated 15-Dec-2007 08:39:56 UTC </div> </div> </body>
